home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / apps / 564 / sub_cal / sub_cal.hlp < prev    next >
Text File  |  1991-09-11  |  21KB  |  471 lines

  1. 6 6 14 50 V.2.00
  2.  
  3.                 *****************
  4.                 **   SUB_CAL   **
  5.                 *****************
  6.  
  7.                    A subset of
  8.          EL_CAL: The Elementary Calculator
  9.         © 1989, 1991  by J.Andrzej Wrotniak
  10.  
  11.          Distributed by Debonair Software
  12.  
  13.   To view a page, click on its top-right corner.
  14.      To change volume or to rearrange pages,
  15.         click on the proper volume number.
  16.                  MENU OPERATIONS
  17. Among options available from the Menu Bar are:
  18. * <Use|Calculator> switches to the Sub_Cal panel.
  19. * <Use|Linear Algebra>  invokes the Linear Algebra
  20.   Panel (see the last Help volume).
  21. * <Options|Switch Screen Colors> - obvious.
  22. * <File|Quit> exits the program.
  23. Most of other entries are  disabled permanently in
  24. Sub_Cal (they are available in El_Cal only).
  25.    Similarly,  screen  buttons   corresponding  to
  26. features  available  only  in the  full El_Cal are
  27. filled with grey; clicking on them has no effect.
  28.    For more about  El_Cal  (in case  you think you
  29. may need it), see Vol.6 of this help file. 
  30.                   DISPLAY LINES
  31. * Most of  the time  Sub_Cal operates  on  display
  32.   lines (in the LCD-like display at the top).
  33. * Display lines  may be  typed in  or entered with
  34.   the mouse. Mouse entries will be always added at
  35.   the end of display line, regardless  of the text
  36.   cursor position.
  37. * Case is not significant and spaces are ignored.
  38. * Switching between  (up to 20) lines  -  by using
  39.   [⇦] and [⇨] at the top.   Clicking  on  the line
  40.   number (between the arrows) jumps to Line 1.
  41. * [⇩] enables  auto-scroll:  after RETURN or clic-
  42.   king  on the  display the  current line  will be
  43.   computed and the next one will be displayed.
  44.        EDITING FUNCTIONS, DATA FORMATTING
  45. * [RST] clears all lines and variables.
  46. * [CLR] clears the current line.
  47. * [BSP] removes the last entry from the line.
  48. * The buttons shown as [F][n] or [E][n] at the top
  49.   set the format (fixed or exponential) and number
  50.   of fractional digits in variable display.   This
  51.   does not affect the accuracy of variables, which
  52.   are always stored with 16-digit precision.
  53. Buttons  allowing  to  echo  all  operations  to a
  54. printer, and to perform disk operations,  are dis-
  55. abled in Sub_Cal.
  56.          COMPUTING DISPLAYED EXPRESSIONS
  57. * Click on the main display (or just press RETURN)
  58.   to compute the current line and store the result
  59.   in the "destination variable" on the right.
  60. * Clicking on [⇨]  and then on a variable from the
  61.   pop-up  menu  will  nominate  a new  destination
  62.   variable and execute the current line.
  63. * Keyboard  shortcut  for the above:  type the ex-
  64.   pression, then "=" and variable name, e.g. 2*3=Z
  65. * To choose destination variable without executing
  66.   the line: click on the destination variable but-
  67.   ton, and then on the variable to choose.
  68. * "✓" left of  display  means,  that  the line was
  69.   computed; next mouse entry will start a new one.
  70.               VARIABLES AND NUMBERS
  71. * Variables  A..Z are  used  to  store data, or as
  72.   components of expressions.
  73. * To modify a variable, double-click on its value.
  74. * To reviev or restore previous values of a varia-
  75.   ble, single-click on its value field.
  76. * Clicking on a variable value while Shift is held
  77.   down will show it with all 16 digits of accuracy
  78. * t is a dummy variable, used in some macros (e.g.
  79.   plotting). It cannot be used to store data.
  80. * Constants:  Ee (Euler's e = 2.71...)  and Pi are
  81.   treated in expressions the same way as variables
  82. * Numbers may use decimal exponent [E]: 1E6 or E6.
  83. * Zero before fraction is optional: .8 means 0.8 .
  84.                     OPERATORS
  85. * Arithmetic operators:    [+], [-], [*], [/], [^]
  86.   (power) have generally accepted priorities.
  87. * Implied multiplication:   the  "*"  sign can  be
  88.   omitted between two variables or between a value
  89.   and variable, e.g. 2A or 6.6PiXY. Implied multi-
  90.   plication has the same priority as "^" (highest)
  91. * Operators  of equal priority are  executed  from
  92.   left  to  right, except for "^" and implied mul-
  93.   tiplication,  e.g.  A^B^CD  ≡  A^(B^(C*D)),  but
  94.   2Pi^3A ≡ 2*(Pi^(3*A)).
  95. * Parentheses () can be nested to any depth;  mis-
  96.   sing ones  at the beginning  and at the end will
  97.   be added, e.g. 5+2)*(8-3  is legal and gives 35.
  98.                FUNCTIONS - GENERAL
  99. * Most of the functions accept a  single argument.
  100.   If  this  argument is  a variable, a value, or a
  101.   product using  implied  multiplication,  then it
  102.   does  not  need  to be enclosed  in parentheses,
  103.   e.g. SIN A or LOG 2Pi, but COS(Pi/3).
  104. * ATN2  and the  statistical functions  accept two
  105.   or three arguments,  which need  to be separated
  106.   with commas, e.g. FGAU(t+.2,2A,B-A) or ATN2(1,1)
  107. * Function evaluation has the same priority as po-
  108.   wer and implied multiplication.  This means that
  109.   EXP A^2 ≡ EXP(A^2) but  EXP 2*A ≡ (EXP 2)*A.
  110. * The [⇦][⇨] buttons switch between three Function
  111.   Panels: Standard, Statistical and User-Defined.
  112.              STANDARD MATH FUNCTIONS
  113. * SIN, COS, TAN, COT may be used with [ARC] and/or
  114.   [HYP] switches, e.g. [ARC][HYP][COT] gives ACOTH
  115. * The [ARC] switch has to be  re-entered  for each
  116.   function, while [HYP] will stay on until reset.
  117. * ATN2(Y,X) computes arctan(y/x) in (0,2Pi)
  118. * The  [Rad]/[Deg]  button sets  the angular mode,
  119.   valid at the computing (not entry!) time.
  120. * LN and EXP  - with base e, 10 or 2 will give LN,
  121.   LOG or LG2 and EXP, TEN and TWO (base to...).
  122.   Choosing the base will  change appropriately the
  123.   text on [LN] and [EXP] buttons.
  124. * ABS, INV - absolute value and reciprocal (1/x).
  125. * INT, FRA - integer and fractional part.
  126.        STATISTICAL DISTRIBUTION FUNCTIONS
  127. Prefixes F, P, Q and A denote the function type:
  128. * F - distribution density
  129. * P - left  probability integral, Prob(X<x)
  130. * Q - right probability integral, Prob(X≥x)
  131. * A - central integral, Prob(abs(X-m)<abs(x-m))
  132. For discrete  cases  "density"  should be replaced
  133. with "probability" and "integral" - with "sum".
  134. X stands here for the random variate, x - for fun-
  135. ction argument and m - for distributon mean value.
  136. * I  preceding  P, Q or A  means  "inverse",  e.g.
  137.   IPGAU(t) returns x for which PGAU(x) = t.
  138.              SUPPORTED DISTRIBUTIONS 
  139.    Sub_Cal supports only  the Gaussian (or Normal)
  140. distribution. To access seven other distributions,
  141. you need the full version of El_Cal.
  142.  
  143.    The [GAU]  button will  enter one  of the seven
  144. possible functions for the Gaussian  distribution,
  145. depending on the status of buttons  [F], [P], [Q],
  146. [A] and [I] described in the previous page.
  147.    These functions accept  three  parameters: x, m
  148. and  s,  where  m  and  s  are mean  and  standard
  149. deviation of the distribution, respectively.
  150.          RANDOM NUMBERS, EULER FUNCTIONS
  151.    A pseudorandom generator function is available:
  152.  
  153. * XGAU(m,s) - from Normal distribution (m,s).
  154.  
  155. (El_Cal supports three other distributions here).
  156. The [S] button reseeds the generator.
  157.  
  158. Natural logarithm  of the  Euler's  Gamma  is also
  159. available LGM(x) - natural logarithm of Gamma(x).
  160.  
  161. (Again, five more related functions are accessible
  162. in El_Cal).
  163.       USER-DEFINED AND CONDITIONAL FUNCTIONS
  164. DF1..DF2 (or just DFx) are user-defined functions:
  165. * [DEF][DFx]  defines the current  line as a func-
  166.   tion with "t" as dummy argument.
  167. * [SHOW][DFx]  recalls a defined  function  to the
  168.   display (e.g. for modification).
  169. * [CLR][DFx] un-defines a function.
  170. * One DFx function can call another,  preceding it
  171.   on the list, e.g. DF2 can call DF1.
  172. IFN, IFZ and IFP  are conditional functions (stan-
  173. ding for "if negative", "if zero", "if positive"):
  174. * IFx(x1,x2,x3) will return x2 if x1 has the requ-
  175.   ired sign, and x3 otherwise. This means that one
  176.   of the (x2,x3) is not being evaluated at all.
  177.           CONSTANTS AND UNIT CONVERSION
  178.  Clicking on [CONST] allows to store a constant in
  179. one of the Sub_Cal variables:
  180. * The button next to "Store" selects the constant,
  181.   one next to "in" chooses the variable.
  182. * Some constants  allow for  a choice of units; in
  183.   such cases a "Converted to" button will appear.
  184. The [UNITS] button calls the unit conversions:
  185. * The  "Convert" button selects the physical quan-
  186.   tity to convert, "From" and "To" select units.
  187. * To convert a variable value, click on the middle
  188.   -right button; the top-right one will prompt for
  189.   a value, and the bottom-right button selects the
  190.   variable to store the result.
  191.        MACROS:  ZERO, INTEGRAL, dF/dt, SUM
  192.  Macros apply to the current line treated as F(t).
  193. The result is sent to the destination variable.
  194. * [ZERO]  finds a (single) zero of  F(t)  within a
  195.   given interval (bisection method is used)
  196. * [INTGR]  computes  integral of F(t) over a given
  197.   interval with given accuracy (Romberg algorithm)
  198. * [dF/dt]  computes  dF(t)/dt  at  given  t  value
  199.   (quadratic approximation with given finite step)
  200. * [SUM] computes a sum of F(t) for given range and
  201.   step in t.
  202. When  the program  asks for required macro parame-
  203. ters, only numbers or  variable  names  (including
  204. Pi and Ee) can be entered - no expressions.
  205.               FUNCTION OPTIMIZATION
  206.    The  [OPTIM]  button on the  Macro Panel allows
  207. for finding a minumum  of the  current line, which
  208. is treated  as  a function  of variables  from the
  209. A..C range.
  210.   Up to 3 variables (in El_Cal: 9) can be selected
  211. as arguments; the function  value will be returned
  212. in the Destination Variable.
  213.   The algorithm, of course,  may end up in a local
  214. extremum  (or a region  with  a very low  function
  215. gradient), so proper care should be excercised.
  216.   Wrong choice of the initial approximation (or of
  217. the function itself)  may lead to a false solution
  218. or to an arithmetic error.
  219.                 POLYNOMIAL ROOTS
  220.   [ROOTS]  calls the Root Panel,  from where roots
  221. of polynomes up to the fourth degree can be found:
  222. * The degree is chosen by clicking  on the buttons
  223.   [1]...[2]. The equation is then displayed below.
  224. * [COMP] solves the equation, with the contents of
  225.   variables A..C as parameters (with non-zero A!).
  226.   Depending on the status of these variables, some
  227.   degree choices will sometimes be disabled.
  228. * Real roots will  be shown in  the Variable Panel
  229.   as u1..u2, and the components of complex conju-
  230.   gate root pairs - as Re and Im.
  231.            NON-LINEAR EQUATION SYSTEMS
  232.   [EQUAT] will display the Equation Panel. Systems
  233. of up to 3 equations  F(A..C)=0 can be solved from
  234. here, with expression lines serving for F() selec-
  235. ted with use of the [1]..[3] buttons.
  236.   Clicking on [SOLV] will show a dialog asking for
  237. selection of unknown variables.  Their number must
  238. be equal to the number of equations. The variables
  239. should contain reasonable initial guesstimates.
  240.   The used Newton-Raphson method has been modified
  241. to accept less accurate initial guesses. If no so-
  242. lution is found, an alert will be displayed.
  243.                 FUNCTION PLOTTING
  244. Click on [PLOTS] to go to the Plotting Panel:
  245. * [PLOT] draws the selected lines as functions  of
  246.   the dummy t. (A..Z can be used as constants).
  247. * Sub_Cal asks for the  t- and y-limits.
  248. * Points for which the function cannot be computed
  249.   will be just ignored.
  250. * Pressing any key will suspend the plotting.
  251. * Click in the plot area for coordinate readout.
  252.         DIFFERENTIAL EQUATIONS - GENERAL
  253. Sub_Cal can solve ODE systems of the form
  254.  dy1/dt = F1(t,y1,yN), ..., dyN/dt = FN(t,y1,yN)
  255. where N may range from 1 to 3. The equations have
  256. to be defined by Display Lines:
  257. * Sub_Cal variable t is used for t above;
  258. * Variables A..C are used for y1..yN;
  259. * For each line its  Destination Variable reflects
  260.   the y whose dy/dt this line computes.
  261. Black buttons  in the  Differential Equation Panel
  262. (invoked by [DIFF]) denote Display Lines  defining
  263. the ODE system.  Each of them has to have a diffe-
  264. rent  Destination Variable.  Sub_Cal variables not
  265. used in this way will be treated as constants.
  266.      DIFFERENTIAL EQUATIONS: SINGLE SOLUTION
  267. To solve an ODE system for a  single value of t:
  268. * Enter the equations  as described above,  select
  269.   the appropriate line buttons (make sure no buton
  270.   is outlined) in the Differental Equation Panel.
  271. * Make sure that the initial y-values are stored
  272.   in corresponding variables A..C;
  273. * Click on [INTEG].
  274. * Answer the prompt for initial and final t-values
  275.   and for the integration accuracy in y. Done.
  276. Pressing any key will suspend the computation with
  277. an option to abort.
  278. The resulting y-values will be  displayed in their
  279. variable fields.
  280.         DIFFERENTIAL EQUATIONS: PLOTTING
  281. The ODE system can also be solved over an interval
  282. with any and all of the solutions plotted.
  283. * Functions to plot are identified by outlining of
  284.   their corresponding buttons (click on a selected
  285.   line  button to  outline it).  The  plot will be
  286.   drawn if one or more line buttons are outlined.
  287. * First a prompt will ask for the starting t-value
  288.   which may be inside or outside of the plot range
  289. * Then  a regular plot  range dialog will  ask for
  290.   the ranges in t and y.  The  former will be used
  291.   for both plotting and integration.
  292. Plotting can be suspended by pressing any key.
  293. There is no display of y-values in this mode.
  294.         STATISTICAL OPERATIONS - GENERAL
  295. * Available modes are  X, XY, WXY (with weights W)
  296.   and DXY (with Y-errors D).   Clicking on [CLEAR]
  297.   or  changing  the mode  (button at  bottom left)
  298.   clears the data buffer.  The current and maximum
  299.   number of data points are shown on the right.
  300. * The data buffer can hold up to  48 points in the
  301.   X mode, up to 24 in the XY mode and up  to 16 in
  302.   the WXY and DXY modes.
  303. (In El_Cal  number of data points  is limited only
  304. by available memory).
  305.            DATA BUFFER MANIPULATION - I
  306.    Clicking  inside the Data Window selects a data
  307. point and presents you with the following options:
  308. * <Edit> - to modify the selected data point,
  309. * <Insert ⇧> or <Insert ⇩> - inserts  a new  point
  310.   before or after the selected one,
  311. * <Move ⇧>, <Move ⇩>, <Move ⇧⇧>, <Move ⇩⇩> - moves
  312.   the selected data point up or down  by one posi-
  313.   tion or all the way, respectively;
  314. * <Delete> - deletes the point from the buffer.
  315.   To add a new data point to the buffer,  click on
  316. the last data point (or in the empty space below).
  317.   Double-clicking on  a value  in the  Data Window
  318. allows for modifying just that value.
  319.            DATA BUFFER MANIPULATION - II
  320.   The window scroll bar  has keyboard equivalents:
  321. ⇧ and ⇩ (page), ⇦ and ⇨ (line), Clr/Home (to top).
  322.   To exit  the  window,  click  on the  closer box
  323. (top-left) or press the Esc key.
  324.   Clicking on the top-right box in the Data Window
  325. presents a menu for global operations:
  326. - <Sort by X>,  <Sort by Y> - in increasing order;
  327. - <Flip X⇦⇨Y> - swap the X- and Y-columns;
  328. - <X⇦F()> etc.  fill a column  with values  of F()
  329.   from the Display Line. X,Y,D and W are interpre-
  330.   ted in F() as data values (if a column exists in
  331.   the current mode), and t - as the point index.
  332. - <Undelete> restores the last deleted data point.
  333.        STATISTICAL OPERATIONS IN THE X-MODE
  334. * [HIST] - plots a histogram of the data; you will
  335.   be prompted  for  the range  and number  of bins
  336.   (maximum of 40).
  337. * [PARAM] - as above, but mean and standard devia-
  338.   tion will be returned as m and s, as well as the
  339.   error  of the mean, dm  (computed for the confi-
  340.   dence level last entered with the [()] button).
  341. * [FIT]  fits the data with a normalized distribu-
  342.   tion defined by the current line as F(t|A..C) -
  343.   a function of t,  with parameters from the A..C
  344.   range.  See the next page for more.
  345.                DISTRIBUTION FITTING
  346.   The distribution-fitting mode is permanently set
  347. to a chi-square fit. Only the bins within the plot
  348. range will be accounted for,  and bins  with  less
  349. than 6 data points  will be combined.
  350.   The destination  variable will  contain the chi-
  351. square  per  degree of freedom  (no. of bins minus
  352. no. of parameters minus one).
  353.   (El_Cal has also another mode, a maximum likeli-
  354. hood fit).
  355.   Initial "reasonable guess"  values  are expected
  356. in parameter variables.
  357.  STATISTICAL OPERATIONS IN XY, WXY AND DXY MODES
  358. * [SCATT] draws a scatter-plot of data points;
  359. * [REGR] - as above,  with  linear  or  polynomial
  360.   regression. First use the degree button, [n], to
  361.   set  the degree (1 or 2).  The  root-mean-square
  362.   deviation from line per degree  of freedom  will
  363.   be returned as s (weighted in WXY and DXY modes)
  364. For degree=1, the linear regression  analysis will
  365. include the correlation coefficient, r,  and slope
  366. and intercept errors, d1 and d0, respectively. The
  367. line confidence  region will also be drawn for the
  368. level as set with the [()] button.
  369. * [FIT] - see the next page.
  370.           MULTI-PARAMETER CURVE FITTING
  371.   [FIT]  will fit the XY, WXY or DXY data sequence
  372. with  an F(t|A..C)  as defined by the current line
  373. (t as argument, A..C as estimated function parame-
  374. ters). 
  375.   The fitting algorithm minimizes the sum of
  376. squared deviations  (El_Cal canm also minimize the
  377. sum of absolute values).
  378.   Parameter  variables  should  be  initialized to
  379. reasonable values  (a good choice will save time).
  380. Root-mean-square deviation  per degree of  freedom
  381. (weighted in DXY and WXY modes)  will be  returned
  382. in the destination variable.
  383.  
  384.  
  385.                     Reserved
  386.  
  387.  
  388.                     Reserved
  389.       DATA OBJECTS IN LINEAR ALGEBRA PANEL
  390. At any moment some of the buttons are disabled, to
  391. make illegal command sequences impossible.
  392. * To see a data object, double-click on its button
  393.   [M1]..[S3]. An array form will be displayed with
  394.   all the object's components visible at once.
  395. * To modify a component, click on it (double click
  396.   will also clear the input field).
  397. * Clicking on  [PUT] will send the displayed value
  398.   to the selected El_Cal variable A..Z, on [GET] -
  399.   fetch a value from the variable to the display.
  400. * The whole object will not be modified  until the
  401.   [Set] button is pressed to exit the object form.
  402.        SIMPLE VECTOR AND MATRIX OPERATIONS
  403.   To use  an object  in  a command,  click  on its
  404. button. The following operations are available:
  405. - Assignment, [⇨], e.g. M1 ⇨ M3 (store M1 in M3);
  406. - Addiction and subtraction:  [+] and [-];
  407. - Scalar (inner) product, [.]:   V.V ⇨ S
  408. - Product, [*], for various operands and results:
  409.   S*S ⇨ S   S*V ⇨ V   V*S ⇨ V   S*M ⇨ M   M*S ⇨ M
  410.   V*V ⇨ M   V*M ⇨ V   M*V ⇨ V   M*M ⇨ M
  411. It is clear from the context, whether the vectors
  412. are  of row  or column nature.
  413.   Additionally,  [*]  can be  used to compute the
  414. cross-product of vectors size three:  V*V ⇨ V.
  415.               MORE MATRIX OPERATIONS
  416. - [DET] for determinant:   Det M ⇨ S
  417. - [TRN] for transposition: Trn M ⇨ M
  418. - [INV] for inversion:     Inv M ⇨ M
  419. - [EQU] solves a system of linear equations:
  420.   M Equ V ⇨ V,  where  M  is the left side matrix
  421.   and the first V - the right side vector.
  422. A command  consists  of one  or two  arguments, an
  423. operator and destination object, e.g. V1*M1 ⇨ V3.
  424. It will be executed only  after  [OK]  is pressed.
  425. Usually [⇨] is entered by the program itself.
  426.   The [STORE], [FETCH] and [PRINT]  buttons invoke
  427. disk and print operations for single data objects.
  428.           OTHER LINEAR ALGEBRA OPTIONS
  429. Other operations in the Linear Algebra Panel are:
  430. - [SIZE] sets the matrix/vector size to 2..4;
  431. - [SAVE] and [LOAD] perform disk  I/O for all data
  432.   objects at once (in a single file);
  433. - [AUTO] enables auto-scroll in data object entry;
  434. - [EXP]  toggles  on/off the  floating point  data
  435.   display format;
  436. - [ECHO]  activates  echoing of  all operations to
  437.   the printer (symbolic notation only);
  438. - [TEXT] allows to output any text to the printer.
  439. All printer operations can be redirected to a disk
  440. file with use of the  <Options|Print to Disk> menu
  441. entry.
  442.                   ABOUT EL_CAL
  443.   Sub_Cal is  a limited  subset  of El_Cal, a more
  444. powerful  mathematical  toolbox,   available  from
  445. Debonair Software. If you find Sub_Cal useful, the
  446. chances are one day you will need the "real thing"
  447. - and the buttons disabled  permanently in Sub_Cal
  448. should give you some  information  about the extra
  449. features and capabilities available in El_Cal.
  450.   More about the differences between both programs
  451. can be found in the accompanying SUB_CAL.DOC file.
  452.   In case of any questions or doubts, do not hesi-
  453. tate to contact us (see the next page).
  454.   If you do  not need El_Cal,  we still  hope  you
  455. will like and enjoy Sub_Cal.
  456.                 DEBONAIR SOFTWARE
  457.  
  458.    EL_CAL sells  for $63 (v.2.0) or $44 (v.1.4, no
  459. differential equations) and is distributed by
  460.          Debonair Software
  461.          P.O.Box 521166
  462.          Salt Lake City, UT 84152-1166.
  463. [Checks or money orders, outside continental US
  464. please add $5 extra.]
  465.  
  466.   Technical  correspondence  can be also forwarded
  467. electronically directly to the author: 
  468.          CompuServe: 70611,2552
  469.          GEnie:      J.WROTNIAK
  470.  
  471.